NAZWA¶

catman - tworzy lub aktualizuje preformatowane strony podręcznika man

SKŁADNIA¶

catman [-dhV] [-M ścieżka] [sekcja] ...

OPIS¶

catman służy do tworzenia i aktualizacji zestawu preformatowanych stron man podręcznika znanych jako strony cat (cat pages). Strony cat są na ogół dużo szybsze do wyświetlenia niż pierwotne strony man, ale wymagają dodatkowego miejsca na ich składowanie. Decyzja o obsłudze stron cat należy do lokalnego administratora, który musi zapewnić odpowiednie katalogi do ich przechowywania.

Opcje polecenia catman opisują hierarchie stron podręcznika man oraz sekcje, jakie mają podlegać preformatowaniu. Domyślnymi hierarchiami (drzewami katalogów) są te, które określono jako 'globalne' w pliku konfiguracyjnym man-db. Domyślne sekcje określa albo podzielona dwukropkami zawartość zmiennej środowiska $MANSECT, albo zestaw standardowy wkompilowany w man, jeżeli $MANSECT jest niezdefiniowana. Wywołanie catman z zestawem rozdzielonych białymi znakami nazw sekcji unieważnia powyższe ustawienia domyślne.

catman do ustalenia, które z plików powinny zostać sformatowane, korzysta z indeksów baz danych (index database cache) związanych z każdą z hierarchii.

OPCJE¶

-d, --debug

Wyświetla informację diagnostyczną (debug).

-M ścieżka, --manpath=ścieżka

Określa alternatywną, rozdzieloną przecinkami, ścieżkę przeszukiwań hierarchii stron man (manpath). Domyślnie są to wszystkie ścieżki wskazane jako 'globalne' w pliku konfiguracyjnym man-db.

-h, --help

Wyświetla komunikat pomocy i kończy pracę.

-V, --version

Wyświetla informację o wersji.

ŚRODOWISKO¶

MANSECT

Jeżeli ustawiona jest $MANSECT, to jej wartość jest listą oddzielonych dwukropkami sekcji i służy do określania, które sekcje podręcznika man i w jakiej kolejności będą przeszukiwane.

MANPATH

Jeżeli ustawiona jest $MANPATH, to jej wartość jest interpretowana jako wskazana do użycia ścieżka przeszukiwań hierarchii stron man. Ścieżka zawiera rozdzielone dwukropkami nazwy hierarchii (katalogów).

PLIKI¶

/etc/man_db.config

plik konfiguracyjny man-db.

/usr/man/index.(bt|db|dir|pag)

Tradycyjny globalny indeks bazy danych.

/var/catman/index.(bt|db|dir|pag)

Alternatywny lub zgodny z FSSTND [standardem organizacji katalogów] globalny indeks bazy danych.

ZOBACZ TAKŻE¶

man(1), manpath(5), mandb(8).

AUTOR¶

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).